docs: don't use <type> tags
authorWilliam Jon McCann <william.jon.mccann@gmail.com>
Tue, 28 Jan 2014 05:06:30 +0000 (00:06 -0500)
committerWilliam Jon McCann <william.jon.mccann@gmail.com>
Tue, 28 Jan 2014 05:21:26 +0000 (00:21 -0500)
Use # syntax where appropriate.

15 files changed:
gdk/gdkevents.h
gdk/x11/gdkcursor-x11.c
gdk/x11/gdkmain-x11.c
gdk/x11/gdkscreen-x11.c
gdk/x11/gdkvisual-x11.c
gdk/x11/gdkwindow-x11.c
gdk/x11/gdkx11cursor.h
gdk/x11/gdkx11screen.h
gdk/x11/gdkx11window.h
gdk/x11/gdkxid.c
gtk/deprecated/gtkstyle.c
gtk/gtkappchooser.c
gtk/gtktreemodel.c
gtk/gtktreestore.c
gtk/gtkwidget.c

index 3dc7b414fb54fa23d661c791376f959bf614a8cc..8425466e23396adc658741e813071d7613bec842 100644 (file)
@@ -165,8 +165,8 @@ typedef void (*GdkEventFunc) (GdkEvent *event,
 /**
  * GdkXEvent:
  *
- * Used to represent native events (<type>XEvent</type>s for the X11
- * backend, <type>MSG</type>s for Win32).
+ * Used to represent native events (XEvents for the X11
+ * backend, MSGs for Win32).
  */
 typedef void GdkXEvent;          /* Can be cast to window system specific
                           * even type, XEvent on X11, MSG on Win32.
@@ -391,7 +391,7 @@ typedef enum
  *
  * Specifies the kind of crossing for #GdkEventCrossing.
  *
- * See the X11 protocol specification of <type>LeaveNotify</type> for
+ * See the X11 protocol specification of LeaveNotify for
  * full details of crossing event generation.
  */
 typedef enum
index de86e6c58ad05c85e2cfee3524b9ba8d0cf5a1ba..3a6534fcefa92ce3a96c9ab2ae5f741d79b780fd 100644 (file)
@@ -291,7 +291,7 @@ _gdk_x11_display_get_cursor_for_type (GdkDisplay    *display,
  * 
  * Returns the display of a #GdkCursor.
  * 
- * Return value: (transfer none): an Xlib <type>Display*</type>.
+ * Return value: (transfer none): an Xlib Display*.
  **/
 Display *
 gdk_x11_cursor_get_xdisplay (GdkCursor *cursor)
@@ -307,7 +307,7 @@ gdk_x11_cursor_get_xdisplay (GdkCursor *cursor)
  * 
  * Returns the X cursor belonging to a #GdkCursor.
  * 
- * Return value: an Xlib <type>Cursor</type>.
+ * Return value: an Xlib Cursor.
  **/
 Cursor
 gdk_x11_cursor_get_xcursor (GdkCursor *cursor)
index 955313bdf41b618a4393402efe5895d00e9fa26d..68d13a5551ddffccc9c3de7fb53b0de4519717d9 100644 (file)
@@ -439,7 +439,7 @@ gdk_x11_get_default_screen (void)
  * Gets the root window of the default screen 
  * (see gdk_x11_get_default_screen()).  
  * 
- * Return value: an Xlib <type>Window</type>.
+ * Return value: an Xlib Window.
  **/
 Window
 gdk_x11_get_default_root_xwindow (void)
@@ -452,7 +452,7 @@ gdk_x11_get_default_root_xwindow (void)
  * 
  * Gets the default GTK+ display.
  * 
- * Return value: (transfer none): the Xlib <type>Display*</type> for
+ * Return value: (transfer none): the Xlib Display* for
  * the display specified in the <option>--display</option> command
  * line option or the <envar>DISPLAY</envar> environment variable.
  **/
index 8fee444c82c2d2a77f4a3eb5f495d8460604c688..feda7b25fe109ecbe4d3061f97d1682fba1028cf 100644 (file)
@@ -424,7 +424,7 @@ gdk_x11_screen_get_rgba_visual (GdkScreen *screen)
  *
  * Returns the screen of a #GdkScreen.
  *
- * Returns: (transfer none): an Xlib <type>Screen*</type>
+ * Returns: (transfer none): an Xlib Screen*
  *
  * Since: 2.2
  */
index 9bbe7e47ea88faf07a126ede464e7fbf3e976d47..0c401f281403e1be89ecb73eb57fd5759ac246ac 100644 (file)
@@ -591,7 +591,7 @@ _gdk_visual_get_x11_colormap (GdkVisual *visual)
  *
  * Returns the X visual belonging to a #GdkVisual.
  *
- * Return value: (transfer none): an Xlib <type>Visual*</type>.
+ * Return value: (transfer none): an Xlib Visual*.
  **/
 Visual *
 gdk_x11_visual_get_xvisual (GdkVisual *visual)
index 22252768fcb8c100a99197081230004200095d4f..3d5de3b8df3c63a3a44c94ecf5b3ccefbfb866b3 100644 (file)
@@ -1173,7 +1173,7 @@ x_event_mask_to_gdk_event_mask (long mask)
 /**
  * gdk_x11_window_foreign_new_for_display:
  * @display: (type GdkX11Display): the #GdkDisplay where the window handle comes from.
- * @window: an XLib <type>Window</type>
+ * @window: an Xlib Window
  *
  * Wraps a native window in a #GdkWindow. The function will try to
  * look up the window using gdk_x11_window_lookup_for_display() first.
index 8fb0b08f752b1077bf5aeffb9dad2e8fe7ad631c..046cf706e72892647b895627fc25613875a86ed0 100644 (file)
@@ -64,7 +64,7 @@ Cursor   gdk_x11_cursor_get_xcursor       (GdkCursor   *cursor);
  *
  * Returns the display of a #GdkCursor.
  *
- * Returns: an Xlib <type>Display*</type>.
+ * Returns: an Xlib Display*.
  */
 #define GDK_CURSOR_XDISPLAY(cursor)   (gdk_x11_cursor_get_xdisplay (cursor))
 
@@ -74,7 +74,7 @@ Cursor   gdk_x11_cursor_get_xcursor       (GdkCursor   *cursor);
  *
  * Returns the X cursor belonging to a #GdkCursor.
  *
- * Returns: an Xlib <type>Cursor</type>.
+ * Returns: an Xlib Cursor.
  */
 #define GDK_CURSOR_XCURSOR(cursor)    (gdk_x11_cursor_get_xcursor (cursor))
 
index 8f91d64e962d30f1413b2cefbaabc168a932883e..cc707dd104693e72da02a37e03d626cec014a64a 100644 (file)
@@ -72,7 +72,7 @@ gint     gdk_x11_get_default_screen       (void);
  *
  * Returns the display of a X11 #GdkScreen.
  *
- * Returns: an Xlib <type>Display*</type>
+ * Returns: an Xlib Display*.
  */
 #define GDK_SCREEN_XDISPLAY(screen) (gdk_x11_display_get_xdisplay (gdk_screen_get_display (screen)))
 
@@ -82,7 +82,7 @@ gint     gdk_x11_get_default_screen       (void);
  *
  * Returns the screen of a X11 #GdkScreen.
  *
- * Returns: an Xlib <type>Screen*</type>
+ * Returns: an Xlib Screen*
  */
 #define GDK_SCREEN_XSCREEN(screen) (gdk_x11_screen_get_xscreen (screen))
 
index 1943c34245d86f971d4a349ec2b58205a7e1020d..d366d3b457bdd79870bd96902bf59f939f215e1b 100644 (file)
@@ -93,7 +93,7 @@ void     gdk_x11_window_set_frame_sync_enabled (GdkWindow *window,
  *
  * Returns the display of a #GdkWindow.
  *
- * Returns: an Xlib <type>Display*</type>.
+ * Returns: an Xlib Display*.
  */
 #define GDK_WINDOW_XDISPLAY(win)      (GDK_DISPLAY_XDISPLAY (gdk_window_get_display (win)))
 
@@ -103,7 +103,7 @@ void     gdk_x11_window_set_frame_sync_enabled (GdkWindow *window,
  *
  * Returns the X window belonging to a #GdkWindow.
  *
- * Returns: the Xlib <type>Window</type> of @win.
+ * Returns: the Xlib Window of @win.
  */
 #define GDK_WINDOW_XID(win)           (gdk_x11_window_get_xid (win))
 
index 448230275c8e4373a1cb807dae92ade2fe99e128..d3029e4d84ec3b62e3a039318be6340fabe5d1b6 100644 (file)
@@ -81,7 +81,7 @@ _gdk_x11_display_remove_window (GdkDisplay *display,
  * gdk_x11_window_lookup_for_display:
  * @display: (type GdkX11Display): the #GdkDisplay corresponding to the
  *           window handle
- * @window: an XLib <type>Window</type>
+ * @window: an Xlib Window
  *
  * Looks up the #GdkWindow that wraps the given native window handle.
  *
index 0a3914b79bab349c79fa2f479b7c2ad3ec6be673..74abf0ac476a0750c0f42fad6c25bb4fe75a814a 100644 (file)
@@ -1172,7 +1172,7 @@ gtk_style_get_style_property (GtkStyle     *style,
  * @style: a #GtkStyle
  * @widget_type: the #GType of a descendant of #GtkWidget
  * @first_property_name: the name of the first style property to get
- * @var_args: a <type>va_list</type> of pairs of property names and
+ * @var_args: a va_list of pairs of property names and
  *     locations to return the property values, starting with the
  *     location for @first_property_name.
  *
index e4037d2c1e0fde5e9772b19c2218012dfa36c2e1..4ee53e86920160984a19143607177281d5454f5c 100644 (file)
@@ -66,7 +66,7 @@ gtk_app_chooser_default_init (GtkAppChooserIface *iface)
    *
    * The content type of the #GtkAppChooser object.
    *
-   * See <link linkend="gio-GContentType"><type>GContentType</type></link>
+   * See <link linkend="gio-GContentType">GContentType</link>
    * for more information about content types.
    */
   pspec = g_param_spec_string ("content-type",
index dfc1503cbe164b2be669bf283e278628cf5ef05e..9fe613b580f39f7b945bcd6f7664fc48b9b03365 100644 (file)
@@ -1733,7 +1733,7 @@ gtk_tree_model_unref_node (GtkTreeModel *tree_model,
  * retrieved.  The list is terminated by a -1. For example, to get a
  * value from column 0 with type %G_TYPE_STRING, you would
  * write: <literal>gtk_tree_model_get (model, iter, 0, &amp;place_string_here, -1)</literal>,
- * where <literal>place_string_here</literal> is a <type>gchar*</type>
+ * where <literal>place_string_here</literal> is a #gchararray
  * to be filled with the string.
  *
  * Returned values with type %G_TYPE_OBJECT have to be unreferenced,
@@ -1759,9 +1759,9 @@ gtk_tree_model_get (GtkTreeModel *tree_model,
  * gtk_tree_model_get_valist:
  * @tree_model: a #GtkTreeModel
  * @iter: a row in @tree_model
- * @var_args: <type>va_list</type> of column/return location pairs
+ * @var_args: va_list of column/return location pairs
  *
- * See gtk_tree_model_get(), this version takes a <type>va_list</type>
+ * See gtk_tree_model_get(), this version takes a va_list
  * for language bindings to use.
  */
 void
index da0cc46b707531eaa924a380174022dcb4d89b9e..a67a01ed47c2fda3a9f195d198a7b9abc95cb4bf 100644 (file)
@@ -308,7 +308,7 @@ gtk_tree_store_init (GtkTreeStore *tree_store)
  *
  * As an example, <literal>gtk_tree_store_new (3, G_TYPE_INT, G_TYPE_STRING,
  * GDK_TYPE_PIXBUF);</literal> will create a new #GtkTreeStore with three columns, of type
- * <type>int</type>, <type>string</type> and #GdkPixbuf respectively.
+ * #gint, #gchararray, and #GdkPixbuf respectively.
  *
  * Return value: a new #GtkTreeStore
  **/
@@ -1125,9 +1125,9 @@ gtk_tree_store_set_valuesv (GtkTreeStore *tree_store,
  * gtk_tree_store_set_valist:
  * @tree_store: A #GtkTreeStore
  * @iter: A valid #GtkTreeIter for the row being modified
- * @var_args: <type>va_list</type> of column/value pairs
+ * @var_args: va_list of column/value pairs
  *
- * See gtk_tree_store_set(); this version takes a <type>va_list</type> for
+ * See gtk_tree_store_set(); this version takes a va_list for
  * use by language bindings.
  *
  **/
index 68b7d28fd5c679ce58083bfc55fa71ebe864b6bf..4e4f589b21bfe84e64074c41cf9a6b66718f3690 100644 (file)
@@ -12533,7 +12533,7 @@ gtk_widget_style_get_property (GtkWidget   *widget,
  * gtk_widget_style_get_valist:
  * @widget: a #GtkWidget
  * @first_property_name: the name of the first property to get
- * @var_args: a <type>va_list</type> of pairs of property names and
+ * @var_args: a va_list of pairs of property names and
  *     locations to return the property values, starting with the location
  *     for @first_property_name.
  *